Cisco-IOS-XR-ip-rsvp-oper API API Reference
API generated from Cisco-IOS-XR-ip-rsvp-oper@2017-09-07.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/{{router}}/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
RSVP-STANDBY - Retrieve
Retrieve operation of resource: rsvp-standby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-standby": {RSVP operational data for standby role
"hello-instance-briefs": {Table of brief info about hello instances
"hello-instance-brief": [No description
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", No description
"instance-type": "string" Hello instance type
}
]
},
"request-briefs": {Table of brief info about requests
"request-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", output Interface
"destination-address": "string", Destination Address
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"source-port": "integer", Source Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"p2mp-id": "integer" P2MP ID
}
]
},
"interface-neighbor-details": {Table of detailed info about I/F neighbors
"interface-neighbor-detail": [No description
{
"neighbor-address": "string", Neighbor address
"interface-neighbor-list-detail": [No description
{
"retransmitted-messages": "integer", Count of messages retransmitted
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Count of Out of Order messages
}
],
"node-address": "string" Neighbor node address
}
]
},
"nsr": {RSVP NSR information
"status": {Status of ERO
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"controller-briefs": {Table of brief info about RSVP-enabled\ncontroller
"controller-brief": [No description
{
"controller-name": "string", Controller Name
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
},
"rsb-detaileds": {Table of detailed info about reservation state\nblocks
"rsb-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"hop": {Hop Infomation
"neighbor-address": "string", Neighbor address
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"input-adjusted-interface": "string", Input Adjusted Interface
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"input-physical-interface": "string", Input Physical Interface
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-port": "integer", Source Port
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
}
},
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"destination-address": "string", Destination Address
"p2mp-id": "integer" P2MP ID
}
]
},
"hello-interface-instance-details": {Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [No description
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
},
"global-neighbor-details": {Table of detailed info about global neighbors
"global-neighbor-detail": [No description
{
"restart-state": "string", Restart state
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Interval at which hello messages are sent
"local-node-address": [No description
{
"entry": "string" Sequence window
}
],
"is-gr-enabled": "boolean", Whether GR is enabled
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [No description
{
"entry": "string" Sequence window
}
],
{
"entry": "string" Sequence window
}
],
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"neighbor-hello-state": [No description
{
"entry": "string" Sequence window
}
],
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"lost-communication-total": [No description
{
"entry": "integer" Sequence window
}
],
"neighbor-address": "string", Neighbor address
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"up-time": [No description
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"recovery-time": "integer", Recovery time (milliseconds)
"node-address": "string", Neighbor node address
"is-restart-timer-running": "boolean", Is GR restart timer running
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
]
},
"rsb-briefs": {Table of brief info about reservation state\nblocks
"rsb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"vrf-name": "string", VRF Name
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"p2mp-id": "integer", P2MP ID
"session-type": "string" SessionType
}
]
},
"counters": {Counters
"interface-messages": {Table of message counters
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", InterfaceName
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
},
"message-summary": {Summary information for all RSVP message\ncounters
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
},
"event-syncs": {Table containing event sync counters
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" InterfaceName
}
]
},
"database": {Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"issu": {Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"prefix-filtering": {Prefix filtering counters
"interfaces": {Number of Interfaces
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total number of instances of this state
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", InterfaceName
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total number of instances of this state
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total number of instances of this state
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
},
"interface-events": {Event counters
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" InterfaceName
}
]
},
"nsr": {Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"out-of-resource": {Out of resource counters
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" InterfaceName
}
]
}
}
}
},
"controller-summaries": {Table of summary info about RSVP-enabled\ncontrollers
"controller-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
},
"interface-briefs": {Table of brief info about RSVP-enabled\ninterfaces
"interface-brief": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", InterfaceName
"interface-name-xr": "string" Interface Name
}
]
},
"session-detaileds": {Table of detailed info about sessions
"session-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-rsb-info": [No description
{
"psb-info": [No description
{
"is-valid": "boolean", Is the label information valid
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" Sequence window
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" Sequence window
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" Sequence window
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" Sequence window
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" Sequence window
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"is-valid": "boolean", Is the label information valid
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" Sequence window
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" Sequence window
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
],
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", SessionType
"p2mp-id": "integer" P2MP ID
}
]
},
"session-briefs": {Table of brief info about sessions
"session-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", SessionType
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
},
"interface-summaries": {Table of summary info about RSVP-enabled\ninterfaces
"interface-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", InterfaceName
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
},
"authentication-briefs": {Table for Authentication related information
"authentication-brief": [No description
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
},
"frr-summary": {Fast Re-Route Summary State Information
"reservation-states": {Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
},
"path-states": {Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
},
"frrs": {Table of detailed info about Fast Re-route\nstates
"frr": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"vrf-name": "string", VRF Name
"reservation-status": "string", RSVP FRR Reservation States
"destination-address": "string", Destination Address
"session-type": "string", SessionType
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"p2mp-id": "integer", P2MP ID
"source-port": "integer" Source Port
}
]
},
"psb-detaileds": {Table of detailed info about path state blocks
"psb-detailed": [No description
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"in-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean", Outgoing ERO validity
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"out-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"hop": {Path Hop Info
"neighbor-address": "string", Neighbor address
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"session-type": "string", SessionType
"destination-port": "integer", The Session Destination Port
"pfc": [No description
{
"output-interface": "string", output Interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
],
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"source-port": "integer", Source Port
"is-in-ero-valid": "boolean", Incoming ERO validity
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Sequence window
}
]
}
}
},
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
]
},
"hello-instance-details": {Table of detailed info about hello instances
"hello-instance-detail": [No description
{
"hello-interval": "integer", Interval at which hello messages are sent
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", No description
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-messages-sent": "integer" Number of hello messages sent
}
]
},
"controller-detaileds": {Table of detailed info about RSVP-enabled\ncontrollers
"controller-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", Neighbor address
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
},
"interface-detaileds": {Table of detailed info about RSVP-enabled\ninterfaces
"interface-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"interface-name": "string", InterfaceName
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", Neighbor address
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
},
"summary": {RSVP summary information
"ls-ps": "integer", Total LSPs
"interfaces": "integer", Number of Interfaces
"issu-status": {Issu status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
},
"database-counters": {All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"nsr-status": {NSR status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"psb-briefs": {Table of brief info about path state blocks
"psb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"destination-address": "string", Destination Address
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-port": "integer", Source Port
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
]
},
"global-neighbor-briefs": {Table of brief info about global neighbors
"global-neighbor-brief": [No description
{
"restart-state": "string", Restart state
"neighbor-address": "string", Neighbor address
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"lost-communication-reason": [No description
{
"entry": "string" Sequence window
}
],
"lost-communication-total": [Total number of times communication got lost
{
"entry": "integer" Sequence window
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [No description
{
"entry": "string" Sequence window
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string", Neighbor node address
"neighbor-hello-state": [No description
{
"entry": "string" Sequence window
}
]
}
]
},
"hello-interface-instance-briefs": {Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [No description
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
},
"request-details": {Table of detail info about requests
"request-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"rsb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"destination-address": "string", Destination Address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"output-interface": "string", output Interface
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"hop": {Hop Infomation
"neighbor-address": "string", Neighbor address
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer" P2MP ID
}
]
},
"interface-neighbor-briefs": {Table of brief info about I/F neighbors
"interface-neighbor-brief": [No description
{
"neighbor-address": "string", Neighbor address
"interface-neighbor-list-compact": [No description
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
},
"authentication-details": {Table for detailed authentication related\ninformation
"authentication-detail": [No description
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
},
"graceful-restart": {Info about graceful-restart
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"hello-interval": "integer", Interval at which hello messages are sent
"global-neighbors": "integer", Global neighbor count
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [No description
{
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
],
"recovery-time": "integer", Recovery time (milliseconds)
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
}
}
INTERFACE-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: interface-neighbor-briefs
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-briefs": {Table of brief info about I/F neighbors
"interface-neighbor-brief": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-compact": [No description
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: interface-neighbor-brief
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-brief": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-compact": [No description
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
}
INTERFACE-NEIGHBOR-LIST-COMPACT - Retrieve
Retrieve operation of resource: interface-neighbor-list-compact
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-compact": {No description
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
}
CONTROLLER-SUMMARIES - Retrieve
Retrieve operation of resource: controller-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summaries": {Table of summary info about RSVP-enabled\ncontrollers
"controller-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
CONTROLLER-SUMMARY - Retrieve
Retrieve operation of resource: controller-summary
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summary": {No description
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
AUTHENTICATION-BRIEFS - Retrieve
Retrieve operation of resource: authentication-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-briefs": {Table for Authentication related information
"authentication-brief": [No description
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
}
}
AUTHENTICATION-BRIEF - Retrieve
Retrieve operation of resource: authentication-brief
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-brief": [No description
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
}
SESSION-BRIEFS - Retrieve
Retrieve operation of resource: session-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-briefs": {Table of brief info about sessions
"session-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
}
}
SESSION-BRIEF - Retrieve
Retrieve operation of resource: session-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
PSB-DETAILEDS - Retrieve
Retrieve operation of resource: psb-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detaileds": {Table of detailed info about path state blocks
"psb-detailed": [No description
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"in-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean", Outgoing ERO validity
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"out-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"session-type": "string", Session Type
"destination-port": "integer", Destination Port
"pfc": [No description
{
"output-interface": "string", Output interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
],
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"source-port": "integer", Source Port
"is-in-ero-valid": "boolean", Incoming ERO validity
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
]
}
}
PSB-DETAILED - Retrieve
Retrieve operation of resource: psb-detailed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detailed": [No description
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"in-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean", Outgoing ERO validity
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"out-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"session-type": "string", Session Type
"destination-port": "integer", Destination Port
"pfc": [No description
{
"output-interface": "string", Output interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
],
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"source-port": "integer", Source Port
"is-in-ero-valid": "boolean", Incoming ERO validity
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
PATH-FLAGS - Retrieve
Retrieve operation of resource: path-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCE-INFO - Retrieve
Retrieve operation of resource: policy-source-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
CLASS-TYPE - Retrieve
Retrieve operation of resource: class-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
}
}
PFC - Retrieve
Retrieve operation of resource: pfc
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfc": {No description
"output-interface": "string", Output interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
IN-ERO - Retrieve
Retrieve operation of resource: in-ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"in-ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
OUT-ERO - Retrieve
Retrieve operation of resource: out-ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
CONTROLLER-DETAILEDS - Retrieve
Retrieve operation of resource: controller-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detaileds": {Table of detailed info about RSVP-enabled\ncontrollers
"controller-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
}
CONTROLLER-DETAILED - Retrieve
Retrieve operation of resource: controller-detailed
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-array": {No description
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-message-id": {No description
"message-id": "string" Message ID
}
}
FRR-SUMMARY - Retrieve
Retrieve operation of resource: frr-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr-summary": {Fast Re-Route Summary State Information
"reservation-states": {Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
},
"path-states": {Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
}
PATH-STATES - Retrieve
Retrieve operation of resource: path-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-states": {Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RESERVATION-STATES - Retrieve
Retrieve operation of resource: reservation-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-states": {Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RSB-DETAILEDS - Retrieve
Retrieve operation of resource: rsb-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detaileds": {Table of detailed info about reservation state\nblocks
"rsb-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"input-adjusted-interface": "string", Input Adjusted Interface
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"input-physical-interface": "string", Input Physical Interface
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-port": "integer", Source Port
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"extended-tunnel-id": "string", Extended Tunnel ID
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"destination-address": "string", Destination Address
"p2mp-id": "integer" P2MP ID
}
]
}
}
RSB-DETAILED - Retrieve
Retrieve operation of resource: rsb-detailed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"input-adjusted-interface": "string", Input Adjusted Interface
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"input-physical-interface": "string", Input Physical Interface
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-port": "integer", Source Port
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"extended-tunnel-id": "string", Extended Tunnel ID
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"destination-address": "string", Destination Address
"p2mp-id": "integer" P2MP ID
}
]
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
RSB-FLAGS - Retrieve
Retrieve operation of resource: rsb-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
INTERFACE-SUMMARIES - Retrieve
Retrieve operation of resource: interface-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summaries": {Table of summary info about RSVP-enabled\ninterfaces
"interface-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summary": {No description
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
HELLO-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-instance-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-briefs": {Table of brief info about hello instances
"hello-instance-brief": [No description
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", Neighbor Hello state
"instance-type": "string" Hello instance type
}
]
}
}
HELLO-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-instance-brief
source-address destination-address:
string
in path
ID of source-address destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-brief": [No description
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", Neighbor Hello state
"instance-type": "string" Hello instance type
}
]
}
AUTHENTICATION-DETAILS - Retrieve
Retrieve operation of resource: authentication-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-details": {Table for detailed authentication related\ninformation
"authentication-detail": [No description
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
}
}
AUTHENTICATION-DETAIL - Retrieve
Retrieve operation of resource: authentication-detail
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-detail": [No description
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
}
AUTH-COMPACT - Retrieve
Retrieve operation of resource: auth-compact
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
DIRECTION-INFO - Retrieve
Retrieve operation of resource: direction-info
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
}
}
SEND-INFO - Retrieve
Retrieve operation of resource: send-info
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
}
RECEIVE-INFO - Retrieve
Retrieve operation of resource: receive-info
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
}
SEQUENCE-WINDOW - Retrieve
Retrieve operation of resource: sequence-window
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence-window": {No description
"entry": "integer" Sequence window
}
}
RSB-BRIEFS - Retrieve
Retrieve operation of resource: rsb-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-briefs": {Table of brief info about reservation state\nblocks
"rsb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Reservation Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"vrf-name": "string", VRF Name
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"p2mp-id": "integer", P2MP ID
"session-type": "string" Session Type
}
]
}
}
RSB-BRIEF - Retrieve
Retrieve operation of resource: rsb-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Reservation Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"vrf-name": "string", VRF Name
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"p2mp-id": "integer", P2MP ID
"session-type": "string" Session Type
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": {Counters
"interface-messages": {Table of message counters
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
},
"message-summary": {Summary information for all RSVP message\ncounters
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
},
"event-syncs": {Table containing event sync counters
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"database": {Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Interface specific prefix filtering counters
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"issu": {Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"prefix-filtering": {Prefix filtering counters
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
},
"interface-events": {Event counters
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"nsr": {Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"out-of-resource": {Out of resource counters
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
}
}
INTERFACE-MESSAGES - Retrieve
Retrieve operation of resource: interface-messages
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-messages": {Table of message counters
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
}
}
INTERFACE-MESSAGE - Retrieve
Retrieve operation of resource: interface-message
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
MESSAGE-SUMMARY - Retrieve
Retrieve operation of resource: message-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-summary": {Summary information for all RSVP message\ncounters
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
PREFIX-FILTERING - Retrieve
Retrieve operation of resource: prefix-filtering
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-filtering": {Prefix filtering counters
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
}
ACCESSES - Retrieve
Retrieve operation of resource: accesses
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
ACCESS - Retrieve
Retrieve operation of resource: access
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"access": {No description
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": {No description
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
OUT-OF-RESOURCE - Retrieve
Retrieve operation of resource: out-of-resource
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-of-resource": {Out of resource counters
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": {No description
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
}
INTERFACE-EVENTS - Retrieve
Retrieve operation of resource: interface-events
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-events": {Event counters
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
}
]
}
}
INTERFACE-EVENT - Retrieve
Retrieve operation of resource: interface-event
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
}
]
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": {Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
DATABASE - Retrieve
Retrieve operation of resource: database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database": {Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
EVENT-SYNCS - Retrieve
Retrieve operation of resource: event-syncs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-syncs": {Table containing event sync counters
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name
}
]
}
}
EVENT-SYNC - Retrieve
Retrieve operation of resource: event-sync
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name
}
]
}
INTERFACE-DETAILEDS - Retrieve
Retrieve operation of resource: interface-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detaileds": {Table of detailed info about RSVP-enabled\ninterfaces
"interface-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"interface-name": "string", Interface Name
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
}
INTERFACE-DETAILED - Retrieve
Retrieve operation of resource: interface-detailed
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"interface-name": "string", Interface Name
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-array": {No description
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-message-id": {No description
"message-id": "string" Message ID
}
}
CONTROLLER-BRIEFS - Retrieve
Retrieve operation of resource: controller-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-briefs": {Table of brief info about RSVP-enabled\ncontroller
"controller-brief": [No description
{
"controller-name": "string", Controller Name
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
}
}
CONTROLLER-BRIEF - Retrieve
Retrieve operation of resource: controller-brief
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-brief": [No description
{
"controller-name": "string", Controller Name
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart": {Info about graceful-restart
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"hello-interval": "integer", Interval at which hello messages are sent
"global-neighbors": "integer", Global neighbor count
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [No description
{
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
],
"recovery-time": "integer", Recovery time (milliseconds)
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-address": {No description
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
}
HELLO-INTERFACE-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-interface-instance-briefs
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-briefs": {Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [No description
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
}
}
HELLO-INTERFACE-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-interface-instance-brief
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-brief": [No description
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
}
HELLO-INTERFACE-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-interface-instance-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-details": {Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [No description
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INTERFACE-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-interface-instance-detail
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-detail": [No description
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
LAST-MESSAGE-SENT-TIME - Retrieve
Retrieve operation of resource: last-message-sent-time
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
INTERFACE-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: interface-neighbor-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-details": {Table of detailed info about I/F neighbors
"interface-neighbor-detail": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-detail": [No description
{
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-detail
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-detail": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-detail": [No description
{
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
],
"node-address": "string" Neighbor node address
}
]
}
INTERFACE-NEIGHBOR-LIST-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-list-detail
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-detail": {No description
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": {RSVP NSR information
"status": {RSVP NSR status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": {RSVP NSR status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": {RSVP summary information
"ls-ps": "integer", Total LSPs
"interfaces": "integer", Number of Interfaces
"issu-status": {Issu status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
},
"database-counters": {All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"nsr-status": {NSR status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
ISSU-STATUS - Retrieve
Retrieve operation of resource: issu-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu-status": {Issu status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
NSR-STATUS - Retrieve
Retrieve operation of resource: nsr-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-status": {NSR status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-counters": {All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
FRRS - Retrieve
Retrieve operation of resource: frrs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frrs": {Table of detailed info about Fast Re-route\nstates
"frr": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"sub-group-id": "integer", Subgroup ID
"vrf-name": "string", VRF Name
"reservation-status": "string", RSVP FRR Reservation States
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"p2mp-id": "integer", P2MP ID
"source-port": "integer" Source Port
}
]
}
}
FRR - Retrieve
Retrieve operation of resource: frr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"sub-group-id": "integer", Subgroup ID
"vrf-name": "string", VRF Name
"reservation-status": "string", RSVP FRR Reservation States
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"p2mp-id": "integer", P2MP ID
"source-port": "integer" Source Port
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
REQUEST-BRIEFS - Retrieve
Retrieve operation of resource: request-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-briefs": {Table of brief info about requests
"request-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", Output Interface
"destination-address": "string", Destination Address
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"source-port": "integer", Source Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-BRIEF - Retrieve
Retrieve operation of resource: request-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", Output Interface
"destination-address": "string", Destination Address
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"source-port": "integer", Source Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQUEST-DETAILS - Retrieve
Retrieve operation of resource: request-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-details": {Table of detail info about requests
"request-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"rsb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"output-interface": "string", output Interface
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-DETAIL - Retrieve
Retrieve operation of resource: request-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"rsb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"output-interface": "string", output Interface
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQ-FLAGS - Retrieve
Retrieve operation of resource: req-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
HEADER - Retrieve
Retrieve operation of resource: header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
PSB-KEY - Retrieve
Retrieve operation of resource: psb-key
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-key": {No description
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type (e.g. LSP, OUNI or UDP)
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", Point-to-multipoint ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
}
RSB-KEY - Retrieve
Retrieve operation of resource: rsb-key
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-key": {No description
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type (e.g. LSP, OUNI or UDP)
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", Point-to-multipoint ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
}
INTERFACE-BRIEFS - Retrieve
Retrieve operation of resource: interface-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-briefs": {Table of brief info about RSVP-enabled\ninterfaces
"interface-brief": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"interface-name-xr": "string" Interface Name
}
]
}
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"interface-name-xr": "string" Interface Name
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
SESSION-DETAILEDS - Retrieve
Retrieve operation of resource: session-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detaileds": {Table of detailed info about sessions
"session-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
}
},
"protocol": "integer", Protocol
"extended-tunnel-id": "string", Extended Tunnel ID
"psb-rsb-info": [No description
{
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
],
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
SESSION-DETAILED - Retrieve
Retrieve operation of resource: session-detailed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
}
},
"protocol": "integer", Protocol
"extended-tunnel-id": "string", Extended Tunnel ID
"psb-rsb-info": [No description
{
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
],
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
COMPACT - Retrieve
Retrieve operation of resource: compact
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
PSB-RSB-INFO - Retrieve
Retrieve operation of resource: psb-rsb-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-rsb-info": {No description
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
}
PSB-INFO - Retrieve
Retrieve operation of resource: psb-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-info": {No description
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
}
GENERIC-IN-LABEL - Retrieve
Retrieve operation of resource: generic-in-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ASSOCIATION - Retrieve
Retrieve operation of resource: association
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV4 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
IPV6 - Retrieve
Retrieve operation of resource: ipv6
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-IPV4 - Retrieve
Retrieve operation of resource: extended-ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV4 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
]
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": {No description
"entry": "integer" Extended Association ID
}
}
EXTENDED-IPV6 - Retrieve
Retrieve operation of resource: extended-ipv6
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": {No description
"entry": "integer" Extended Association ID
}
}
PROTECTION - Retrieve
Retrieve operation of resource: protection
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
}
LSP-FLAGS - Retrieve
Retrieve operation of resource: lsp-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
LINK-FLAGS - Retrieve
Retrieve operation of resource: link-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
}
}
REVERSE-LSP - Retrieve
Retrieve operation of resource: reverse-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" rsvp mgmt rev lsp unsupported subobj
}
]
}
]
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ERO - Retrieve
Retrieve operation of resource: ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
UNSUP-SUB-OBJECT - Retrieve
Retrieve operation of resource: unsup-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unsup-sub-object": {No description
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" rsvp mgmt rev lsp unsupported subobj
}
]
}
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ - Retrieve
Retrieve operation of resource: rsvp-mgmt-rev-lsp-unsupported-subobj
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": {No description
"entry": "integer" rsvp mgmt rev lsp unsupported subobj
}
}
ERO - Retrieve
Retrieve operation of resource: ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
RRO - Retrieve
Retrieve operation of resource: rro
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rro": {No description
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": {No description
"entry": "integer" The RRO Subobject Variable Length Label
}
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject SRLGs
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": {No description
"entry": "integer" The RRO Subobject SRLGs
}
}
RSB-INFO - Retrieve
Retrieve operation of resource: rsb-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-info": {No description
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
}
GENERIC-OUT-LABEL - Retrieve
Retrieve operation of resource: generic-out-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
RRO - Retrieve
Retrieve operation of resource: rro
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rro": {No description
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": {No description
"entry": "integer" The RRO Subobject Variable Length Label
}
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject SRLGs
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": {No description
"entry": "integer" The RRO Subobject SRLGs
}
}
HELLO-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-instance-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-details": {Table of detailed info about hello instances
"hello-instance-detail": [No description
{
"hello-interval": "integer", Hello Interval
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", Neighbor Hello state
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-instance-detail
source-address destination-address:
string
in path
ID of source-address destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-detail": [No description
{
"hello-interval": "integer", Hello Interval
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", Neighbor Hello state
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
source-address destination-address:
string
in path
ID of source-address destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
COMMUNICATION-LOST-TIME - Retrieve
Retrieve operation of resource: communication-lost-time
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
GLOBAL-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: global-neighbor-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-details": {Table of detailed info about global neighbors
"global-neighbor-detail": [No description
{
"restart-state": "string", Current restart state
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Hello Interval (milliseconds)
"local-node-address": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"is-gr-enabled": "boolean", Is GR enabled
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [No description
{
"entry": "string" Total number of times communication got lost
}
],
{
"entry": "string" Total number of times communication got lost
}
],
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"neighbor-hello-state": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"lost-communication-total": [No description
{
"entry": "integer" Total number of times communication got lost
}
],
"neighbor-address": "string", Address of global neighbor
"missed-hellos": "integer", Hello missed count
"up-time": [No description
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"recovery-time": "integer", GR Recovery Time (milliseconds)
"node-address": "string", Neighbor node address
"is-restart-timer-running": "boolean", Is GR restart timer running
"pending-states": "integer", Number of pending states for this neighbor
"is-recovery-timer-running": "boolean", Is RSVP recovery timer running
"restart-time": "integer" GR Restart Time (milliseconds)
}
]
}
}
GLOBAL-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: global-neighbor-detail
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-detail": [No description
{
"restart-state": "string", Current restart state
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Hello Interval (milliseconds)
"local-node-address": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"is-gr-enabled": "boolean", Is GR enabled
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [No description
{
"entry": "string" Total number of times communication got lost
}
],
{
"entry": "string" Total number of times communication got lost
}
],
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"neighbor-hello-state": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"lost-communication-total": [No description
{
"entry": "integer" Total number of times communication got lost
}
],
"neighbor-address": "string", Address of global neighbor
"missed-hellos": "integer", Hello missed count
"up-time": [No description
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"recovery-time": "integer", GR Recovery Time (milliseconds)
"node-address": "string", Neighbor node address
"is-restart-timer-running": "boolean", Is GR restart timer running
"pending-states": "integer", Number of pending states for this neighbor
"is-recovery-timer-running": "boolean", Is RSVP recovery timer running
"restart-time": "integer" GR Restart Time (milliseconds)
}
]
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
RESTART-TIME-LEFT - Retrieve
Retrieve operation of resource: restart-time-left
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RESTART-TIMER-EXPIRY-TIME - Retrieve
Retrieve operation of resource: restart-timer-expiry-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-address": {No description
"entry": "string" Local node address
}
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor": {No description
"entry": "string" Interface Neighbor List
}
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-hello-state": {No description
"entry": "string" Neighbor's hello state
}
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-reason": {No description
"entry": "string" Reason why communication was lost
}
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-total": {No description
"entry": "integer" Total number of times communication got lost
}
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
PSB-BRIEFS - Retrieve
Retrieve operation of resource: psb-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-briefs": {Table of brief info about path state blocks
"psb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"destination-address": "string", Destination address
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-port": "integer", Source Port
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
]
}
}
PSB-BRIEF - Retrieve
Retrieve operation of resource: psb-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"destination-address": "string", Destination address
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-port": "integer", Source Port
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GLOBAL-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: global-neighbor-briefs
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-briefs": {Table of brief info about global neighbors
"global-neighbor-brief": [No description
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"lost-communication-reason": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"entry": "integer" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean", Is GR enabled
"local-node-address": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string", Neighbor node address
"neighbor-hello-state": [No description
{
"entry": "string" Neighbor Hello state
}
]
}
]
}
}
GLOBAL-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: global-neighbor-brief
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-brief": [No description
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"lost-communication-reason": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"entry": "integer" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean", Is GR enabled
"local-node-address": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string", Neighbor node address
"neighbor-hello-state": [No description
{
"entry": "string" Neighbor Hello state
}
]
}
]
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-address": {No description
"entry": "string" Local node address
}
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-hello-state": {No description
"entry": "string" Neighbor Hello state
}
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-reason": {No description
"entry": "string" Reason why communication was lost
}
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-total": {No description
"entry": "integer" Total number of times communication got lost
}
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RSVP - Retrieve
Retrieve operation of resource: rsvp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp": {rsvp
"hello-instance-briefs": {Table of brief info about hello instances
"hello-instance-brief": [No description
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", No description
"instance-type": "string" Hello instance type
}
]
},
"request-briefs": {Table of brief info about requests
"request-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", output Interface
"destination-address": "string", Destination address
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"source-port": "integer", Source Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"p2mp-id": "integer" P2MP ID
}
]
},
"hello-interface-instance-briefs": {Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [No description
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
},
"interface-neighbor-details": {Table of detailed info about I/F neighbors
"interface-neighbor-detail": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-detail": [No description
{
"retransmitted-messages": "integer", Count of messages retransmitted
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Count of Out of Order messages
}
],
"node-address": "string" Neighbor node address
}
]
},
"nsr": {RSVP NSR information
"status": {Status of ERO
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"controller-briefs": {Table of brief info about RSVP-enabled\ncontroller
"controller-brief": [No description
{
"controller-name": "string", Controller Name
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
},
"rsb-detaileds": {Table of detailed info about reservation state\nblocks
"rsb-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"hop": {Hop Infomation
"neighbor-address": "string", Address of global neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"input-adjusted-interface": "string", Input Adjusted Interface
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"input-physical-interface": "string", Input Physical Interface
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-port": "integer", Source Port
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"label-info": {Label Information
"is-valid": "boolean", Entry validity
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
}
},
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"destination-address": "string", Destination address
"p2mp-id": "integer" P2MP ID
}
]
},
"hello-interface-instance-details": {Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [No description
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
},
"rxsb-details": {Table of detailed RXSB info
"rxsb-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"destination-address": "string", Destination address
"dynamic-state": "integer", Dynamic State Handle
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"hop": {Path Hop Info
"neighbor-address": "string", Address of global neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
]
},
"global-neighbor-details": {Table of detailed info about global neighbors
"global-neighbor-detail": [No description
{
"restart-state": "string", Restart state
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Interval at which hello messages are sent
"local-node-address": [No description
{
"entry": "string" Neighbor Hello state
}
],
"is-gr-enabled": "boolean", Whether GR is enabled
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"entry": "string" Neighbor Hello state
}
],
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"neighbor-hello-state": [No description
{
"entry": "string" Neighbor Hello state
}
],
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"lost-communication-total": [No description
{
"entry": "integer" Neighbor Hello state
}
],
"neighbor-address": "string", Address of global neighbor
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"up-time": [No description
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"recovery-time": "integer", Recovery time (milliseconds)
"node-address": "string", Neighbor node address
"is-restart-timer-running": "boolean", Is GR restart timer running
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
]
},
"rsb-briefs": {Table of brief info about reservation state\nblocks
"rsb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"vrf-name": "string", VRF Name
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"p2mp-id": "integer", P2MP ID
"session-type": "string" SessionType
}
]
},
"authentication-details": {Table for detailed authentication related\ninformation
"authentication-detail": [No description
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination address
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Neighbor Hello state
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": {Basic authentication data
"neighbor-address": "string", Address of global neighbor
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
},
"controller-summaries": {Table of summary info about RSVP-enabled\ncontrollers
"controller-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
},
"interface-briefs": {Table of brief info about RSVP-enabled\ninterfaces
"interface-brief": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"interface-name-xr": "string" Interface Name
}
]
},
"psb-detaileds": {Table of detailed info about path state blocks
"psb-detailed": [No description
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"in-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean", Outgoing ERO validity
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"out-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"hop": {Path Hop Info
"neighbor-address": "string", Address of global neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"session-type": "string", SessionType
"destination-port": "integer", The Session Destination Port
"pfc": [No description
{
"output-interface": "string", output Interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
],
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"source-port": "integer", Source Port
"is-in-ero-valid": "boolean", Incoming ERO validity
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"label-info": {Label Information
"is-valid": "boolean", Entry validity
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
}
},
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
]
},
"session-detaileds": {Table of detailed info about sessions
"session-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-rsb-info": [No description
{
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" Neighbor Hello state
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" Neighbor Hello state
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" Neighbor Hello state
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" Neighbor Hello state
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Neighbor Hello state
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" Neighbor Hello state
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" Neighbor Hello state
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
],
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-id": "integer" P2MP ID
}
]
},
"session-briefs": {Table of brief info about sessions
"session-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination address
"session-type": "string", SessionType
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
},
"interface-summaries": {Table of summary info about RSVP-enabled\ninterfaces
"interface-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
},
"authentication-briefs": {Table for Authentication related information
"authentication-brief": [No description
{
"neighbor-address": "string", Address of global neighbor
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
},
"frr-summary": {Fast Re-Route Summary State Information
"reservation-states": {Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total count of messages
"ready-instances": "integer" Number of ready instances of this state
},
"path-states": {Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total count of messages
"ready-instances": "integer" Number of ready instances of this state
}
},
"frrs": {Table of detailed info about Fast Re-route\nstates
"frr": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"vrf-name": "string", VRF Name
"reservation-status": "string", RSVP FRR Reservation States
"destination-address": "string", Destination address
"session-type": "string", SessionType
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"p2mp-id": "integer", P2MP ID
"source-port": "integer" Source Port
}
]
},
"pxsb-details": {Table of detailed PXSB info
"pxsb-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"hop": {Path Hop Info
"neighbor-address": "string", Address of global neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"destination-address": "string", Destination address
"dynamic-state": "integer", Dynamic State Handle
"source-port": "integer", Source Port
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"sub-group-origin": "string", Subgroup Origin
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"input-interface": "string", Path Input Interface
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer" P2MP ID
}
]
},
"bw-pool-info": {All B/W Pool info
"is-bc1-percent-configured": "boolean", Is BC1 default I/F percent configured
"max-res-pool-percent": "integer", Maxium reservable I/F percent B/W
"is-bc0-percent-configured": "boolean", Is BC0 default I/F percent configured
"bc0-percent": "integer", BC0 I/F percent B/W
"bc1-percent": "integer", BC1 I/F percent B/W
"is-max-res-pool-percent-configured": "boolean", Is maximum reservable default I/F percent\nconfigured
"bandwidth-configuration-model": "string" Bandwith configuration model currently in use\n(MAM/RDM)
},
"hello-instance-details": {Table of detailed info about hello instances
"hello-instance-detail": [No description
{
"hello-interval": "integer", Interval at which hello messages are sent
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination address
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", No description
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-messages-sent": "integer" Number of hello messages sent
}
]
},
"controller-detaileds": {Table of detailed info about RSVP-enabled\ncontrollers
"controller-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", Address of global neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
},
"interface-detaileds": {Table of detailed info about RSVP-enabled\ninterfaces
"interface-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", Address of global neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
},
"summary": {RSVP summary information
"ls-ps": "integer", Total LSPs
"interfaces": "integer", Interface specific prefix filtering counters
"issu-status": {Issu status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
},
"database-counters": {All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Interface specific prefix filtering counters
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"nsr-status": {NSR status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"psb-briefs": {Table of brief info about path state blocks
"psb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"destination-address": "string", Destination address
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-port": "integer", Source Port
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
]
},
"global-neighbor-briefs": {Table of brief info about global neighbors
"global-neighbor-brief": [No description
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"lost-communication-reason": [No description
{
"entry": "string" Neighbor Hello state
}
],
"lost-communication-total": [Total number of times communication got lost
{
"entry": "integer" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string", Neighbor node address
"neighbor-hello-state": [No description
{
"entry": "string" Neighbor Hello state
}
]
}
]
},
"issu": {RSVP ISSU information
"status": {RSVP ISSU status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
},
"request-details": {Table of detail info about requests
"request-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"rsb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"output-interface": "string", output Interface
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"hop": {Hop Infomation
"neighbor-address": "string", Address of global neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer" P2MP ID
}
]
},
"interface-neighbor-briefs": {Table of brief info about I/F neighbors
"interface-neighbor-brief": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-compact": [No description
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
},
"counters": {Counters
"interface-messages": {Table of message counters
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
},
"message-summary": {Summary information for all RSVP message\ncounters
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
},
"event-syncs": {Table containing event sync counters
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"database": {Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Interface specific prefix filtering counters
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"issu": {Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"prefix-filtering": {Prefix filtering counters
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
},
"interface-events": {Event counters
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"nsr": {Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"out-of-resource": {Out of resource counters
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
},
"graceful-restart": {Info about graceful-restart
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"hello-interval": "integer", Interval at which hello messages are sent
"global-neighbors": "integer", Global neighbor count
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [No description
{
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
],
"recovery-time": "integer", Recovery time (milliseconds)
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {RSVP ISSU information
"status": {RSVP ISSU status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": {RSVP ISSU status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
BW-POOL-INFO - Retrieve
Retrieve operation of resource: bw-pool-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bw-pool-info": {All B/W Pool info
"is-bc1-percent-configured": "boolean", Is BC1 default I/F percent configured
"max-res-pool-percent": "integer", Maxium reservable I/F percent B/W
"is-bc0-percent-configured": "boolean", Is BC0 default I/F percent configured
"bc0-percent": "integer", BC0 I/F percent B/W
"bc1-percent": "integer", BC1 I/F percent B/W
"is-max-res-pool-percent-configured": "boolean", Is maximum reservable default I/F percent\nconfigured
"bandwidth-configuration-model": "string" Bandwith configuration model currently in use\n(MAM/RDM)
}
}
PXSB-DETAILS - Retrieve
Retrieve operation of resource: pxsb-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pxsb-details": {Table of detailed PXSB info
"pxsb-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"protocol": "integer", Protocol
"source-address": "string", Source Address
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"destination-address": "string", Destination Address
"dynamic-state": "integer", Dynamic State Handle
"source-port": "integer", Source Port
"extended-tunnel-id": "string", Extended Tunnel ID
"sub-group-origin": "string", Subgroup Origin
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"input-interface": "string", Path Input Interface
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
PXSB-DETAIL - Retrieve
Retrieve operation of resource: pxsb-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pxsb-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"protocol": "integer", Protocol
"source-address": "string", Source Address
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"destination-address": "string", Destination Address
"dynamic-state": "integer", Dynamic State Handle
"source-port": "integer", Source Port
"extended-tunnel-id": "string", Extended Tunnel ID
"sub-group-origin": "string", Subgroup Origin
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"input-interface": "string", Path Input Interface
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
RSVP-HEADER - Retrieve
Retrieve operation of resource: rsvp-header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
RXSB-DETAILS - Retrieve
Retrieve operation of resource: rxsb-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rxsb-details": {Table of detailed RXSB info
"rxsb-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"dynamic-state": "integer", Dynamic State Handle
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
]
}
}
RXSB-DETAIL - Retrieve
Retrieve operation of resource: rxsb-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rxsb-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"destination-address": "string", Destination Address
"dynamic-state": "integer", Dynamic State Handle
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"source-port": "integer", Source Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"extended-tunnel-id": "string", Extended Tunnel ID
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer", P2MP ID
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
RSVP-HEADER - Retrieve
Retrieve operation of resource: rsvp-header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-header": {RSVP Header
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
INTERFACE-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: interface-neighbor-briefs
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-briefs": {Table of brief info about I/F neighbors
"interface-neighbor-brief": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-compact": [No description
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: interface-neighbor-brief
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-brief": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-compact": [No description
{
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
],
"node-address": "string" Neighbor node address
}
]
}
INTERFACE-NEIGHBOR-LIST-COMPACT - Retrieve
Retrieve operation of resource: interface-neighbor-list-compact
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-compact": {No description
"neighbor-interface-name": "string", Neighbor's Interface handle
"interface-neighbor-address": "string" Interface Neighbor address
}
}
CONTROLLER-SUMMARIES - Retrieve
Retrieve operation of resource: controller-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summaries": {Table of summary info about RSVP-enabled\ncontrollers
"controller-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
CONTROLLER-SUMMARY - Retrieve
Retrieve operation of resource: controller-summary
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-summary": {No description
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"reservations-out": "integer", Number of outgoing reservation states
"interface-name-xr": "string", Interface Name
"paths-in": "integer", Number of locally created and incoming path\nstates
"controller-name": "string", Controller Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
AUTHENTICATION-BRIEFS - Retrieve
Retrieve operation of resource: authentication-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-briefs": {Table for Authentication related information
"authentication-brief": [No description
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
}
}
AUTHENTICATION-BRIEF - Retrieve
Retrieve operation of resource: authentication-brief
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-brief": [No description
{
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"destination-address": "string", Destination Address
"mode-id": "string", Mode (Tx or Rx)
"key-id": "integer" Key ID
}
]
}
SESSION-BRIEFS - Retrieve
Retrieve operation of resource: session-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-briefs": {Table of brief info about sessions
"session-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
}
}
SESSION-BRIEF - Retrieve
Retrieve operation of resource: session-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"rs-bs": "integer", Number of reservation state block states
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"detail-list-size": "integer", Number of elements in detail list
"requests": "integer", Number of request states
"ps-bs": "integer", Number of path state block states
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
PSB-DETAILEDS - Retrieve
Retrieve operation of resource: psb-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detaileds": {Table of detailed info about path state blocks
"psb-detailed": [No description
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"in-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean", Outgoing ERO validity
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"out-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"session-type": "string", Session Type
"destination-port": "integer", Destination Port
"pfc": [No description
{
"output-interface": "string", Output interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
],
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"source-port": "integer", Source Port
"is-in-ero-valid": "boolean", Incoming ERO validity
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
]
}
}
PSB-DETAILED - Retrieve
Retrieve operation of resource: psb-detailed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-detailed": [No description
{
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"in-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-out-ero-valid": "boolean", Outgoing ERO validity
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"out-ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"backup-tunnel-name": "string", Path Backup Tunnel
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"vrf-name": "string", VRF Name
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"p2mp-id": "integer", P2MP ID
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"session-type": "string", Session Type
"destination-port": "integer", Destination Port
"pfc": [No description
{
"output-interface": "string", Output interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
],
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination Address
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"source-port": "integer", Source Port
"is-in-ero-valid": "boolean", Incoming ERO validity
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
PATH-FLAGS - Retrieve
Retrieve operation of resource: path-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-flags": {Path Flags
"is-bidirectional": "boolean", Bidirectional
"is-lockout": "boolean", Locked Out
"is-non-rsvp-hop-upstream": "boolean", Non-RSVP Hop Upstream
"is-message-id-valid": "boolean", MessageID Valid
"is-local-sender": "boolean", Local Sender
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Path Hop Info
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCE-INFO - Retrieve
Retrieve operation of resource: policy-source-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-source-info": {Policy Sources Info
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": {RSVP Header Info
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
CLASS-TYPE - Retrieve
Retrieve operation of resource: class-type
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"class-type": {DS-TE Class-Type
"is-class-type-info-valid": "boolean", Is the Class-Type information valid
"class-type": "integer" DS-TE Class-Type
}
}
PFC - Retrieve
Retrieve operation of resource: pfc
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pfc": {No description
"output-interface": "string", Output interface
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {Policy Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
IN-ERO - Retrieve
Retrieve operation of resource: in-ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"in-ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
OUT-ERO - Retrieve
Retrieve operation of resource: out-ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
CONTROLLER-DETAILEDS - Retrieve
Retrieve operation of resource: controller-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detaileds": {Table of detailed info about RSVP-enabled\ncontrollers
"controller-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
}
CONTROLLER-DETAILED - Retrieve
Retrieve operation of resource: controller-detailed
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"controller-name": "string", Controller Name
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-array": {No description
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-message-id": {No description
"message-id": "string" Message ID
}
}
FRR-SUMMARY - Retrieve
Retrieve operation of resource: frr-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr-summary": {Fast Re-Route Summary State Information
"reservation-states": {Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
},
"path-states": {Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
}
PATH-STATES - Retrieve
Retrieve operation of resource: path-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"path-states": {Path state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RESERVATION-STATES - Retrieve
Retrieve operation of resource: reservation-states
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reservation-states": {Rerservation state counters
"active-instances": "integer", Number of active instances of this state
"active-wait-instances": "integer", Number of instances of this state awaiting Path\nmessages to be sent out or Resv messages to be\nreceived
"total": "integer", Total number of instances of this state
"ready-instances": "integer" Number of ready instances of this state
}
}
RSB-DETAILEDS - Retrieve
Retrieve operation of resource: rsb-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detaileds": {Table of detailed info about reservation state\nblocks
"rsb-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"input-adjusted-interface": "string", Input Adjusted Interface
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"input-physical-interface": "string", Input Physical Interface
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-port": "integer", Source Port
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"extended-tunnel-id": "string", Extended Tunnel ID
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"destination-address": "string", Destination Address
"p2mp-id": "integer" P2MP ID
}
]
}
}
RSB-DETAILED - Retrieve
Retrieve operation of resource: rsb-detailed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"input-adjusted-interface": "string", Input Adjusted Interface
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"input-physical-interface": "string", Input Physical Interface
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-port": "integer", Source Port
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"extended-tunnel-id": "string", Extended Tunnel ID
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
},
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"destination-address": "string", Destination Address
"p2mp-id": "integer" P2MP ID
}
]
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
RSB-FLAGS - Retrieve
Retrieve operation of resource: rsb-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-flags": {Reservation State Block Flags
"is-lockout": "boolean", Locked Out
"is-merge-point": "boolean", Is node a Merge Point
"is-local-receiver": "boolean", Local Receiver
"is-message-id-valid": "boolean", MessageID Valid
"is-local-repair": "boolean" Rerouted
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
HEADER - Retrieve
Retrieve operation of resource: header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry Time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
LABEL-INFO - Retrieve
Retrieve operation of resource: label-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-info": {Label Information
"is-valid": "boolean", Is the label information valid
"lsp-wrap-label": "string", LSP Wrap Label
"local-downstream-label": "string", Local Downstream Label
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"outgoing-downstream-label": "string", Outgoing Downstream Label
"local-upstream-label": "string", Local Upstream Label
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"recovery-label": "string", Recovery Label
"outgoing-upstream-label": "string", Outgoing Upstream Label
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
},
"merge-point-label": "string", MergePoint Label
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
}
GENERIC-LOCAL-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-downstream-label": {Generic Local Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-DOWNSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-downstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-downstream-label": {Generic Outgoing Downstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-MERGE-POINT-LABEL - Retrieve
Retrieve operation of resource: generic-merge-point-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-merge-point-label": {Generic MergePoint Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-OUTGOING-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-outgoing-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-outgoing-upstream-label": {Generic Outgoing Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-LOCAL-UPSTREAM-LABEL - Retrieve
Retrieve operation of resource: generic-local-upstream-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-local-upstream-label": {Generic Local Upstream Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
GENERIC-RECOVERY-LABEL - Retrieve
Retrieve operation of resource: generic-recovery-label
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-recovery-label": {Generic Recovery Label
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
INTERFACE-SUMMARIES - Retrieve
Retrieve operation of resource: interface-summaries
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summaries": {Table of summary info about RSVP-enabled\ninterfaces
"interface-summary": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
]
}
}
INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: interface-summary
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-summary": {No description
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"reservations-out": "integer", Number of outgoing reservation states
"paths-in": "integer", Number of locally created and incoming path\nstates
"interface-name-xr": "string", Interface Name
"reservations-in": "integer", Number of locally created and incoming\nreservation states
"paths-out": "integer" Number of outgoing path states
}
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
HELLO-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-instance-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-briefs": {Table of brief info about hello instances
"hello-instance-brief": [No description
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", Neighbor Hello state
"instance-type": "string" Hello instance type
}
]
}
}
HELLO-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-instance-brief
source-address destination-address:
string
in path
ID of source-address destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-brief": [No description
{
"source-address": "string", Source Address
"lost-communication-total": "integer", Total number of times communication got lost
"destination-address": "string", Destination Address
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"neighbor-hello-state": "string", Neighbor Hello state
"instance-type": "string" Hello instance type
}
]
}
AUTHENTICATION-DETAILS - Retrieve
Retrieve operation of resource: authentication-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-details": {Table for detailed authentication related\ninformation
"authentication-detail": [No description
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
}
}
AUTHENTICATION-DETAIL - Retrieve
Retrieve operation of resource: authentication-detail
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-detail": [No description
{
"lifetime-left": "integer", Remaining lifetime (seconds)
"interface-name": "string", InterfaceName
"source-address": "string", Source Address
"key-digest-info": "integer", Direction
"key-status": "integer", Key status
"challenge-status": "string", Challenge status
"destination-address": "string", Destination Address
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
},
"lifetime": "integer", Lifetime (seconds)
"mode-id": "string", Mode (Tx or Rx)
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
]
}
AUTH-COMPACT - Retrieve
Retrieve operation of resource: auth-compact
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"auth-compact": {Basic authentication data
"neighbor-address": "string", Neighbor address
"direction": "string", Direction
"key-source": "string", Key source
"key-type": "string", Key type
"key-id-valid": "integer", Key validity
"destination-address-xr": "string", Destination address
"source-address-xr": "string", Source address
"key-id": "integer" Key ID
}
}
DIRECTION-INFO - Retrieve
Retrieve operation of resource: direction-info
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"direction-info": {direction info
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
},
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
},
"auth-direction": "string" AuthDirection
}
}
SEND-INFO - Retrieve
Retrieve operation of resource: send-info
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"send-info": {send info
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
},
"sequence": "integer" Sequence number
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": {Counters
"authentication-challenge-responses-sent": "integer", Challenge responses sent
"authentication-sent": "integer", Messages sent
"authentication-send-challenges-received": "integer", Challenges received
"authentication-failures": "integer" Failures
}
}
RECEIVE-INFO - Retrieve
Retrieve operation of resource: receive-info
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"receive-info": {receive info
"sequence-window-size": "integer", Sequence window size
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
},
"sequence-window-count": "integer", Sequence window count
"sequence-window": [No description
{
"entry": "integer" Sequence window
}
],
"sequence": "integer" Sequence number
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": {Counters
"authentication-received-no-integrity": "integer", Authentication received with no integrity
"authentication-received-incomplete": "integer", Authentication received incomplete
"authentication-received-valid-messages": "integer", Valid messages
"authentication-received-sequence-number-duplicate": "integer", Authentication received with duplicate sequence\nnumber
"authentication-received-sequence-number-outof-range": "integer", Authentication received with sequence number out\nof range
"authentication-received-challenge-timeouts": "integer", Challenge timeouts
"authentication-received-challenges-response-duplicate": "integer", Duplicate challenge responses received
"authentication-received-challenges-resent": "integer", Challenges resent
"authentication-received-challenge-response": "integer", Challenge responses received
"authentication-received-response-late": "integer", Challenge responses received late
"authentication-received-challenges-sent": "integer", Challenges sent
"authentication-received-bad-digest": "integer", Authentication received with bad digest
"authentication-received-during-challenge": "integer", Authentication received during challenge
"authentication-received-wrong-challenges-response": "integer", Incorect challenge responses received
"authentication-received-bad-message-format": "integer", Authentication received with bad mesage format
"authentication-received-wrong-digest-type": "integer" Authentication received with wrong digest type
}
}
SEQUENCE-WINDOW - Retrieve
Retrieve operation of resource: sequence-window
source-address destination-address mode-id interface-name:
string
in path
ID of source-address destination-address mode-id interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sequence-window": {No description
"entry": "integer" Sequence window
}
}
RSB-BRIEFS - Retrieve
Retrieve operation of resource: rsb-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-briefs": {Table of brief info about reservation state\nblocks
"rsb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Reservation Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"vrf-name": "string", VRF Name
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"p2mp-id": "integer", P2MP ID
"session-type": "string" Session Type
}
]
}
}
RSB-BRIEF - Retrieve
Retrieve operation of resource: rsb-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Reservation Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"vrf-name": "string", VRF Name
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"p2mp-id": "integer", P2MP ID
"session-type": "string" Session Type
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Info
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
COUNTERS - Retrieve
Retrieve operation of resource: counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"counters": {Counters
"interface-messages": {Table of message counters
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
},
"message-summary": {Summary information for all RSVP message\ncounters
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
},
"event-syncs": {Table containing event sync counters
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"database": {Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Interface specific prefix filtering counters
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"issu": {Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"prefix-filtering": {Prefix filtering counters
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
},
"interface-events": {Event counters
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
},
"nsr": {Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
},
"out-of-resource": {Out of resource counters
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
}
}
INTERFACE-MESSAGES - Retrieve
Retrieve operation of resource: interface-messages
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-messages": {Table of message counters
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
}
}
INTERFACE-MESSAGE - Retrieve
Retrieve operation of resource: interface-message
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-message": [No description
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
]
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
MESSAGE-SUMMARY - Retrieve
Retrieve operation of resource: message-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"message-summary": {Summary information for all RSVP message\ncounters
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"retransmitted-messages": "integer", Count of messages retransmitted
"rate-limited-messages": "integer", Count of Rate Limited messages
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
},
"out-of-order-messages": "integer" Count of Out of Order messages
}
}
RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: received-messages
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"received-messages": {Count of messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: transmitted-messages
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"transmitted-messages": {Count of messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-RECEIVED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-received-messages
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-received-messages": {Count of Bundle messages received
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
BUNDLE-TRANSMITTED-MESSAGES - Retrieve
Retrieve operation of resource: bundle-transmitted-messages
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bundle-transmitted-messages": {Count of Bundle messages transmitted
"ack": "integer", Count of ACK messages
"challenge": "integer", Count of Integrity Challenge messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"bundle": "integer", Count of Bundle messages
"response": "integer", Count of Integrity Response messages
"srefresh": "integer", Count of Srefresh messages
"path-error": "integer", Count of PathError messages
"reservation-error": "integer", Count of ReservationError messages
"reservation": "integer", Count of Reservation messages
"path": "integer", Count of Path messages
"path-tear": "integer", Count of PathTear messages
"hello": "integer", Count of Hello messages
"reservation-tear": "integer" Count of ReservationTear messages
}
}
PREFIX-FILTERING - Retrieve
Retrieve operation of resource: prefix-filtering
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-filtering": {Prefix filtering counters
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
},
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
}
ACCESSES - Retrieve
Retrieve operation of resource: accesses
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"accesses": {AccessList specific prefix filtering counters
"access": [No description
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
ACCESS - Retrieve
Retrieve operation of resource: access
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"access": {No description
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"access-list-name": "string", AccessList Name
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
access-list-name:
string
in path
ID of access-list-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": {Count of total messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Interface specific prefix filtering counters
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
},
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": {Summary of prefix filtering counts for all\ninterfaces
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Table of interface specific prefix filtering\ncounters
"interface": [No description
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": {No description
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"interface-name": "string", Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
},
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
}
FORWARDED - Retrieve
Retrieve operation of resource: forwarded
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"forwarded": {Count of messages which got forwarded
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
LOCALLY-DESTINED - Retrieve
Retrieve operation of resource: locally-destined
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"locally-destined": {Count of locally destined messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DROPPED - Retrieve
Retrieve operation of resource: dropped
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dropped": {Count of messages dropped
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-DROPPED - Retrieve
Retrieve operation of resource: default-action-dropped
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-dropped": {Count of messages which got dropped due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
DEFAULT-ACTION-PROCESSED - Retrieve
Retrieve operation of resource: default-action-processed
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-action-processed": {Count of messages which were processed due to\ndefault ACL action
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
TOTAL - Retrieve
Retrieve operation of resource: total
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"total": {Total count of messages
"total": "integer", Total count of messages
"path": "integer", Count of Path messages
"reservation-confirm": "integer", Count of ReservationConfirm messages
"path-tear": "integer" Count of PathTear messages
}
}
OUT-OF-RESOURCE - Retrieve
Retrieve operation of resource: out-of-resource
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out-of-resource": {Out of resource counters
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Interface specific out of resource counters
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
},
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": {Summary of out of resource counts for all\ninterfaces
"dropped-path-messages": "integer" Count of Path messages dropped due to an out of\nresource condition
}
}
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interfaces": {Table of interface specific out of resource\ncounters
"interface": [No description
{
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
]
}
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": {No description
"dropped-path-messages": "integer", Count of Path messages dropped due to an out of\nresource condition
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g.\nfor routed packets)
}
}
INTERFACE-EVENTS - Retrieve
Retrieve operation of resource: interface-events
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-events": {Event counters
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
}
]
}
}
INTERFACE-EVENT - Retrieve
Retrieve operation of resource: interface-event
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-event": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name. 'None' is used internally\nwhere the true interface is unknown (e.g. for\nrouted packets)
}
]
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": {Summary information for all RSVP NSR counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
ISSU - Retrieve
Retrieve operation of resource: issu
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu": {Summary information for all RSVP ISSU counters
"total-id-ts": "integer", Total number of IDTs
"last-cleared-timestamp": "integer", The timestamp, in seconds, when these statistics\nare cleared since 00:00:00 UTC,\nJanuary 1, 1970
"total-states": "integer", Total number of states
"last-idt-states": "integer", Last IDT number of states
"total-deletions": "integer", Total number of deletions
"rsvp-process-role": "string", Process role
"total-nacks": "integer" Total number of NACKs
}
}
DATABASE - Retrieve
Retrieve operation of resource: database
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database": {Summary information for all RSVP database\ncounters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
EVENT-SYNCS - Retrieve
Retrieve operation of resource: event-syncs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-syncs": {Table containing event sync counters
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name
}
]
}
}
EVENT-SYNC - Retrieve
Retrieve operation of resource: event-sync
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"event-sync": [No description
{
"nac-ks": "integer", Counter for NACKs received
"expired-paths": "integer", Counter for Expired Path states
"expired-reservations": "integer", Counter for Expired Reservation states
"interface-name": "string" Interface Name
}
]
}
INTERFACE-DETAILEDS - Retrieve
Retrieve operation of resource: interface-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detaileds": {Table of detailed info about RSVP-enabled\ninterfaces
"interface-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"interface-name": "string", Interface Name
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
}
INTERFACE-DETAILED - Retrieve
Retrieve operation of resource: interface-detailed
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-detailed": [No description
{
"ack-max-size": "integer", Max size for ACK message
"expiry-timer-state": "string", Expiry timer state
"summary-refresh-max-size": "integer", Max size in bytes of a single SRefresh
"integrity-send-password": "string", Integrity send password
"expiry-interval": "string", Expiry interval in msecs
"pacing-timer-state": "string", State of pacing timer
"interface-name-xr": "string", Interface Name
"integrity-receive-password-optional": "integer", Integrity recv password optional
"pacing-message-rate": "integer", No. of messages per interval
"bundle-message-max-size": "integer", Max size in bytes of a single Bundle message
"out-of-band-refresh-interval": "integer", Out-of-band Refresh interval in msecs
"ack-hold-time": "integer", ACK hold time in msec
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
},
"interface-name": "string", Interface Name
"refresh-timer-state": "string", Refresh timer state
"summary-refresh-timer-state": "string", Summary refresh timer state
"refresh-interval": "string", Refresh interval in msecs
"pacing-messages": "string", Number of messages deferred for pacing
"pacing-interval": "integer", Pacing interval in msecs
"integrity-receive-password": "string", Integrity receive password
"expiry-drops-tolerated": "string", Number of missed messages tolerated
"signalling-ip-tos": "integer", IP TOS (precedence/DSCP) to use in signalling\nmessages
"expiry-states": "string", Number of states for expiry check
"retransmit-time": "integer", Retransmit time in msec
"neighbor-array": [No description
{
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
],
"out-of-band-expiry-drops-tolerated": "integer", Number of out-of-band missed messages tolerated
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {Interface flags
"is-rel-s-refresh-enabled": "boolean", Use reliable xmt for SRefresh
"is-interface-down": "boolean", Interface is DOWN
"is-backup-tunnel": "boolean", This is backup tunnel
"is-mpls-enabled": "boolean", MPLS enabled on interface
"is-s-refresh-enabled": "boolean", Summary Refresh enabled
"is-refresh-enabled": "boolean", Refresh enabled
"is-pacing-enabled": "boolean", Message pacing enabled
"is-non-default-vrf": "boolean", Interface is defined in non-Default VRF
"is-refresh-reduction-enabled": "boolean", Refresh Reduction enabled
"is-message-bundling-enabled": "boolean", Use bundling for outgoing RSVP messages.
"is-interface-created": "boolean", Interface is created
"is-rsvp-configured": "boolean" RSVP explicitly configured
}
}
NEIGHBOR-ARRAY - Retrieve
Retrieve operation of resource: neighbor-array
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-array": {No description
"neighbor-address": "string", IP address of the neighbor
"outgoing-states": "string", Number of outgoing states to the neighbour
"neighbor-message-id": [No description
{
"message-id": "string" Message ID
}
],
"message-ids": "integer", Number of MessageIDs
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"is-neighbor-refresh-reduction-capable": "boolean" Is neighbor capable of Refresh Reduction
}
}
EXPIRY-TIME - Retrieve
Retrieve operation of resource: expiry-time
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"expiry-time": {Expiry time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
NEIGHBOR-MESSAGE-ID - Retrieve
Retrieve operation of resource: neighbor-message-id
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-message-id": {No description
"message-id": "string" Message ID
}
}
CONTROLLER-BRIEFS - Retrieve
Retrieve operation of resource: controller-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-briefs": {Table of brief info about RSVP-enabled\ncontroller
"controller-brief": [No description
{
"controller-name": "string", Controller Name
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
}
}
CONTROLLER-BRIEF - Retrieve
Retrieve operation of resource: controller-brief
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"controller-brief": [No description
{
"controller-name": "string", Controller Name
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name-xr": "string" Interface Name
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
controller-name:
string
in path
ID of controller-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
controller-name:
string
in path
ID of controller-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"graceful-restart": {Info about graceful-restart
"missed-hellos": "integer", Max number of hellos missed before hellos\ndeclared down
"hello-interval": "integer", Interval at which hello messages are sent
"global-neighbors": "integer", Global neighbor count
"is-gr-enabled": "boolean", Whether GR is enabled
"local-node-address": [No description
{
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
],
"recovery-time": "integer", Recovery time (milliseconds)
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"pending-states": "integer", Total number of pending states
"is-recovery-timer-running": "boolean", Whether recovery timer is running
"restart-time": "integer" Restart time (milliseconds)
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-address": {No description
"local-node-ip-address": "string", Local node address
"application-type": "string" GR local node-id app type
}
}
HELLO-INTERFACE-INSTANCE-BRIEFS - Retrieve
Retrieve operation of resource: hello-interface-instance-briefs
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-briefs": {Table of brief info about i/f-based hello\ninstances
"hello-interface-instance-brief": [No description
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
}
}
HELLO-INTERFACE-INSTANCE-BRIEF - Retrieve
Retrieve operation of resource: hello-interface-instance-brief
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-brief": [No description
{
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address": "string", Source Address
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-address-xr": "string" Source address
}
]
}
HELLO-INTERFACE-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-interface-instance-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-details": {Table of detailed info about i/f-based hello\ninstances
"hello-interface-instance-detail": [No description
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INTERFACE-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-interface-instance-detail
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-interface-instance-detail": [No description
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"source-address": "string", Source Address
"hello-messages-received": "integer", Number of hello messages received
"hello-global-neighbor-id": "string", Global Neighbor ID
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"destination-address": "string", Destination Address
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
LAST-MESSAGE-SENT-TIME - Retrieve
Retrieve operation of resource: last-message-sent-time
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-message-sent-time": {Last Ack/msg sent time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
INTERFACE-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: interface-neighbor-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-details": {Table of detailed info about I/F neighbors
"interface-neighbor-detail": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-detail": [No description
{
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
],
"node-address": "string" Neighbor node address
}
]
}
}
INTERFACE-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-detail
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-detail": [No description
{
"neighbor-address": "string", Address of global neighbor
"interface-neighbor-list-detail": [No description
{
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
],
"node-address": "string" Neighbor node address
}
]
}
INTERFACE-NEIGHBOR-LIST-DETAIL - Retrieve
Retrieve operation of resource: interface-neighbor-list-detail
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor-list-detail": {No description
"retransmitted-messages": "integer", Number of retransmitted msgs
"neighbor-epoch": "integer", Neighbor's epoch value
"neighbor-interface-name": "string", Neighbor's Interface handle
"is-rr-enabled": "boolean", Is Neighbor's RR enable
"interface-neighbor-address": "string", Interface Neighbor address
"out-of-order-messages": "integer" Number of out of order msgs
}
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr": {RSVP NSR information
"status": {RSVP NSR status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
STATUS - Retrieve
Retrieve operation of resource: status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": {RSVP NSR status information
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"summary": {RSVP summary information
"ls-ps": "integer", Total LSPs
"interfaces": "integer", Number of Interfaces
"issu-status": {Issu status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
},
"database-counters": {All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
},
"nsr-status": {NSR status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
}
ISSU-STATUS - Retrieve
Retrieve operation of resource: issu-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"issu-status": {Issu status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
NSR-STATUS - Retrieve
Retrieve operation of resource: nsr-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nsr-status": {NSR status
"role": "string", Process role
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
},
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
}
IDT-STATUS - Retrieve
Retrieve operation of resource: idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"idt-status": {IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
PREVIOUS-IDT-STATUS - Retrieve
Retrieve operation of resource: previous-idt-status
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"previous-idt-status": {Previous IDT status
"withdraw-time": "integer", Withdraw ready timestamp in seconds
"idt-start-time": "integer", IDT start timestamp in seconds
"idt-end-time": "integer", IDT end timestamp in seconds
"declare-time": "integer", Declare ready timestamp in seconds
"not-ready-reason": "string", Not ready reason
"sync-status": "string" Sync status
}
}
DATABASE-COUNTERS - Retrieve
Retrieve operation of resource: database-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"database-counters": {All database counters
"incoming-paths": "integer", Number of locally created and incoming path\nstates
"sessions": "integer", Number of sessions
"interfaces": "integer", Number of Interfaces
"outgoing-paths": "integer", Number of outgoing path states
"outgoing-reservations": "integer", Number of outgoing reservation states
"incoming-reservations": "integer" Number of locally created and incoming\nreservation states
}
}
FRRS - Retrieve
Retrieve operation of resource: frrs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frrs": {Table of detailed info about Fast Re-route\nstates
"frr": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"sub-group-id": "integer", Subgroup ID
"vrf-name": "string", VRF Name
"reservation-status": "string", RSVP FRR Reservation States
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"p2mp-id": "integer", P2MP ID
"source-port": "integer" Source Port
}
]
}
}
FRR - Retrieve
Retrieve operation of resource: frr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"frr": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"path-status": "string", RSVP FRR Path States
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"sub-group-id": "integer", Subgroup ID
"vrf-name": "string", VRF Name
"reservation-status": "string", RSVP FRR Reservation States
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"p2mp-id": "integer", P2MP ID
"source-port": "integer" Source Port
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
REQUEST-BRIEFS - Retrieve
Retrieve operation of resource: request-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-briefs": {Table of brief info about requests
"request-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", Output Interface
"destination-address": "string", Destination Address
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"source-port": "integer", Source Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-BRIEF - Retrieve
Retrieve operation of resource: request-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
},
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"output-interface": "string", Output Interface
"destination-address": "string", Destination Address
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"source-port": "integer", Source Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"extended-tunnel-id": "string", Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQUEST-DETAILS - Retrieve
Retrieve operation of resource: request-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-details": {Table of detail info about requests
"request-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"rsb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"output-interface": "string", output Interface
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer" P2MP ID
}
]
}
}
REQUEST-DETAIL - Retrieve
Retrieve operation of resource: request-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"request-detail": [No description
{
"destination-port": "integer", The Session Destination Port
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
},
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"rsb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
},
"destination-address": "string", Destination address
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
},
"source-port": "integer", Source Port
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
},
"output-interface": "string", output Interface
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"psb-key": [No description
{
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", SessionType
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", P2MP ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
],
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
},
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
},
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
},
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
},
"p2mp-id": "integer" P2MP ID
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow Spec Information
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec Information
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
FILTER - Retrieve
Retrieve operation of resource: filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"filter": {RSVP Filter
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
STYLE - Retrieve
Retrieve operation of resource: style
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"style": {RSVP Style
"reservation-type": "string" The Reservation Type: WF, SE or FF
}
}
REQ-FLAGS - Retrieve
Retrieve operation of resource: req-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"req-flags": {Request flags
"is-rro-in-path": "boolean", The Path message contains RRO
"is-send-confirm": "boolean", Send Confirm message
"is-merge-point": "boolean", Is node a Merge Point
"is-refreshing": "boolean", Is neighbor refreshing
"is-ack-outstanding": "boolean", Is ACK message outstanding
"is-retransmit": "boolean", Retransmit the message
"is-label-request-in-path": "boolean", The Path message contains Label Request
"is-nack-received": "boolean", A NACK message was received
"is-record-label-in-path": "boolean", Path has Session-Attr object with Record Labels\nset
"is-message-id-allocated": "boolean", Is MessageID allocated
"is-paced": "boolean", Message is paced
"is-local-receiver": "boolean" Local Receiver
}
}
HOP - Retrieve
Retrieve operation of resource: hop
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hop": {Hop Infomation
"neighbor-address": "string", IP address of the neighbor
"neighbor-logical-interface-name": "string" Neighbor Logical Interface Name
}
}
HEADER - Retrieve
Retrieve operation of resource: header
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"header": {RSVP Header Information
"rsvp-version": "integer", RSVP Version
"ip-ttl": "integer", IP TTL
"ip-tos": "integer", IP Type of Service
"rsvp-header-flags": "integer", RSVP Header Flags (defined in RFC2205 Section 3\n.1.1)
"ip-source-address": "string", IP Source Address
"rsvp-message-type": "integer", RSVP Message Type
"rsvp-ttl": "integer" RSVP TTL
}
}
POLICY-SOURCES - Retrieve
Retrieve operation of resource: policy-sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-sources": {RSVP Policy Sources
"is-local": "boolean", Policy Source is Local
"is-cops": "boolean", Policy Source is COPS
"is-cable": "boolean", Policy Source is Cable
"is-default": "boolean", Policy Source is Default
"is-te-link": "boolean" Policy Source is TE Link
}
}
POLICY-FLAGS - Retrieve
Retrieve operation of resource: policy-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-flags": {RSVP Policy Flags
"is-installed": "boolean", Installed
"is-accepted": "boolean", Accepted
"is-forwarding": "boolean" Forwarding
}
}
POLICY-QUERY-FLAGS - Retrieve
Retrieve operation of resource: policy-query-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"policy-query-flags": {RSVP Query Flags
"is-bypass": "boolean", Bypass
"is-report-required": "boolean", Report Required
"is-resync": "boolean", Resynchronization
"is-needed": "boolean" Needed
}
}
PSB-KEY - Retrieve
Retrieve operation of resource: psb-key
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-key": {No description
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type (e.g. LSP, OUNI or UDP)
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", Point-to-multipoint ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
}
RSB-KEY - Retrieve
Retrieve operation of resource: rsb-key
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-key": {No description
"vrfid": "string", Signalling VRF ID
"protocol": "integer", Protocol. UDP session type this represents the\nProtocol (UDP not supported at present)
"extended-tunnel-id": "string", Protocol or Extended Tunnel ID. For the LSP and\nOUNI sesion types this represents the Extended\nTunnel ID
"source-address": "string", Source Address
"destination-port-or-tunnel-id": "integer", Destination Port or Tunnel ID. For the LSP and\nOUNI session types this represents the Tunnel ID\nwhereas for the UDP session type this represents\nthe Destination Port
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"destination-address": "string", Destination address
"session-type": "string", Session Type (e.g. LSP, OUNI or UDP)
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"p2mp-id": "integer", Point-to-multipoint ID
"source-port-or-lsp-id": "integer" Source Port or LSP_ID. For the LSP and OUNI\nsession types this represents the LSP_ID whereas\nfor the UDP session type this represents the\nSourcePort
}
}
INTERFACE-BRIEFS - Retrieve
Retrieve operation of resource: interface-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-briefs": {Table of brief info about RSVP-enabled\ninterfaces
"interface-brief": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"interface-name-xr": "string" Interface Name
}
]
}
}
INTERFACE-BRIEF - Retrieve
Retrieve operation of resource: interface-brief
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-brief": [No description
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
},
"interface-name": "string", Interface Name
"interface-name-xr": "string" Interface Name
}
]
}
BANDWIDTH-INFORMATION - Retrieve
Retrieve operation of resource: bandwidth-information
interface-name:
string
in path
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bandwidth-information": {Interface bandwidth information
"dste-mode": "string", DSTEMode
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
},
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
}
PRE-STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: pre-standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"pre-standard-dste-interface": {Prestandard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"is-max-subpool-bandwidth-absolute": "boolean", True if the Max sub-pool B/W is an absolute\nvalue and false if its a percentage
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"max-subpool-bandwidth": "integer", Max bandwidth (bits per second) allowed in\nsubpool
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
STANDARD-DSTE-INTERFACE - Retrieve
Retrieve operation of resource: standard-dste-interface
interface-name:
string
in path
ID of interface-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"standard-dste-interface": {Standard DSTE interface information
"is-max-bandwidth-absolute": "boolean", True if the Max B/W is an absolute value and\nfalse if its a percentage
"max-pool1-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC1\npool
"allocated-bit-rate": "integer", Bandwidth (bits per second) now allocated
"max-pool0-bandwidth": "integer", Max bandwidth (bits per second) allowed in BC0\npool
"max-flow-bandwidth": "integer", Max bandwidth (bits per second) allowed per flow
"is-max-bc1-bandwidth-absolute": "boolean", True if the Max BC1 sub-pool B/W is an absolute\nvalue and false if its a percentage
"is-max-bc0-bandwidth-absolute": "boolean", True if the Max BC0 B/W is an absolute value and\nfalse if its a percentage
"max-bandwidth": "integer" Max bandwidth (bits per second) allowed
}
}
SESSION-DETAILEDS - Retrieve
Retrieve operation of resource: session-detaileds
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detaileds": {Table of detailed info about sessions
"session-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
}
},
"protocol": "integer", Protocol
"extended-tunnel-id": "string", Extended Tunnel ID
"psb-rsb-info": [No description
{
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
],
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
}
SESSION-DETAILED - Retrieve
Retrieve operation of resource: session-detailed
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-detailed": [No description
{
"destination-port": "integer", The Session Destination Port
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-tunnel-id": "string" Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination Address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol
"destination-address": "string" Destination Address
},
"session-type": "string", Session Type
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", P2MP ID
"extended-tunnel-id": "string" Extended Tunnel ID
}
}
}
},
"protocol": "integer", Protocol
"extended-tunnel-id": "string", Extended Tunnel ID
"psb-rsb-info": [No description
{
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination Address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination Address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
],
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"vrf-name": "string", VRF Name
"destination-address": "string", Destination Address
"session-type": "string", Session Type
"p2mp-id": "integer" P2MP ID
}
]
}
COMPACT - Retrieve
Retrieve operation of resource: compact
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"compact": {Compact session data
"rs-bs": "integer", Number of reservation state block states
"ps-bs": "integer", Number of path state block states
"requests": "integer", Number of request states
"detail-list-size": "integer", Number of elements in detail list
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
PSB-RSB-INFO - Retrieve
Retrieve operation of resource: psb-rsb-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-rsb-info": {No description
"psb-info": [No description
{
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
],
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
]
}
}
PSB-INFO - Retrieve
Retrieve operation of resource: psb-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-info": {No description
"is-valid": "boolean", Entry validity
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
]
},
"lsp-wrap-label": "string", LSP Wrap Label
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
"is-rro-valid": "boolean", RRO validity
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
},
"destination-address": "string", Destination address
"tunnel-name": "string", Tunnel name
"in-label": "string", Label for inbound traffic
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
},
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"in-interface": "string", Interface on which inbound message was received
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-bad-address": "boolean", Address validity
"is-traffic-spec-valid": "boolean", Traffic Spec validity
"incoming-interface-address": "string", IP address of Path's incoming interface
"is-ero-valid": "boolean", ERO validity
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"lsp-id": "integer" LSP ID
}
}
GENERIC-IN-LABEL - Retrieve
Retrieve operation of resource: generic-in-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-in-label": {Generic Label for inbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {Traffic Spec object
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ASSOCIATION - Retrieve
Retrieve operation of resource: association
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"association": {Association object
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
]
},
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
},
"association-type": "string", AssociationType
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {IPV4 ASSOCIATION Object
"source": "string", Association IPV4 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
IPV6 - Retrieve
Retrieve operation of resource: ipv6
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv6": {IPV6 ASSOCIATION Object
"source": "string", Association IPV6 Source Address
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-IPV4 - Retrieve
Retrieve operation of resource: extended-ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv4": {EXTENDED IPV4 ASSOCIATION Object
"source": "string", Association IPV4 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer", Association ID
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
]
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": {No description
"entry": "integer" Extended Association ID
}
}
EXTENDED-IPV6 - Retrieve
Retrieve operation of resource: extended-ipv6
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-ipv6": {EXTENDED IPV6 ASSOCIATION Object
"extended-id": [No description
{
"entry": "integer" Extended Association ID
}
],
"source": "string", Association IPV6 Source Address
"global-source": "integer", Global Association Source
"type": "integer", Association Type (RFC 4872)
"id": "integer" Association ID
}
}
EXTENDED-ID - Retrieve
Retrieve operation of resource: extended-id
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"extended-id": {No description
"entry": "integer" Extended Association ID
}
}
PROTECTION - Retrieve
Retrieve operation of resource: protection
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"protection": {Protection object
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
},
"s": "boolean", Secondary Bit
"o": "boolean", Operational Bit
"n": "boolean", Notification Bit
"p": "boolean", Protecting Bit
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
}
LSP-FLAGS - Retrieve
Retrieve operation of resource: lsp-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lsp-flags": {PROTECTION Object LSP Flags
"rerouting-no-et": "boolean", Rerouting Without Extra-Traffic
"one-plus-one-uni": "boolean", 1+1 Unidirectional Protection
"one-plus-one-bi": "boolean", 1+1 Bidirectional Protection
"rerouting": "boolean", Full Rerouting
"one-to-n-protection-et": "boolean" 1:N Protection with Extra-Traffic
}
}
LINK-FLAGS - Retrieve
Retrieve operation of resource: link-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-flags": {PROTECTION Object Link Flags
"reserved-bit2": "boolean", Reserved Bit 2
"reserved-bit1": "boolean", Reserved Bit 1
"unprotected": "boolean", LSP should not use any Link Layer Protection
"ded1-plus1": "boolean", Dedicated 1+1 Protection
"enhanced": "boolean", Indicates Enhanced Protection Scheme
"shared": "boolean", Shared Link Layer Protection
"extra-traffic": "boolean", LSP should use Links that are protecting other\n(primary) traffic
"ded1-to1": "boolean" Dedicated 1:1 Protection
}
}
REVERSE-LSP - Retrieve
Retrieve operation of resource: reverse-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reverse-lsp": {Reverse LSP object
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"ero": [No description
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
],
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" rsvp mgmt rev lsp unsupported subobj
}
]
}
]
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {Generic Traffic Spec object
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
ERO - Retrieve
Retrieve operation of resource: ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
UNSUP-SUB-OBJECT - Retrieve
Retrieve operation of resource: unsup-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unsup-sub-object": {No description
"rsvp-mgmt-rev-lsp-unsupported-subobj": [No description
{
"entry": "integer" rsvp mgmt rev lsp unsupported subobj
}
]
}
}
RSVP-MGMT-REV-LSP-UNSUPPORTED-SUBOBJ - Retrieve
Retrieve operation of resource: rsvp-mgmt-rev-lsp-unsupported-subobj
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-mgmt-rev-lsp-unsupported-subobj": {No description
"entry": "integer" rsvp mgmt rev lsp unsupported subobj
}
}
ERO - Retrieve
Retrieve operation of resource: ero
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ero": {No description
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
},
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
},
"ero-type": "string" EROType
}
}
IPV4ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4ero-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4ero-sub-object": {IPV4 ERO Sub Object
"prefix-length": "integer", ERO Prefix Length
"ero-address": "string", The ERO IPV4 Address
"is-strict-route": "boolean" ERO Entry Is Strict
}
}
UNNUMBERED-ERO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-ero-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-ero-sub-object": {Unnumbered ERO Sub Object
"status": "string", Status of ERO
"ero-interface-id": "integer", The Interface ID in ERO
"is-strict-route": "boolean", ERO Entry Is Strict
"ero-router-id": "string" The Router ID in ERO
}
}
RRO - Retrieve
Retrieve operation of resource: rro
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rro": {No description
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": {No description
"entry": "integer" The RRO Subobject Variable Length Label
}
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject SRLGs
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": {No description
"entry": "integer" The RRO Subobject SRLGs
}
}
RSB-INFO - Retrieve
Retrieve operation of resource: rsb-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsb-info": {No description
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
}
},
"is-valid": "boolean", Entry validity
"out-interface": "string", Interface on which outbound message was sent
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
},
"backup-interface": "string", Backup tunnel interface
"rro": [No description
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
],
"is-rro-valid": "boolean", RRO validity
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
},
"destination-address": "string", Destination address
"backup-label": "string", Backup label
"out-label": "string", Label for outbound traffic
"is-flow-spec-valid": "boolean" FlowSpec validity
}
}
GENERIC-OUT-LABEL - Retrieve
Retrieve operation of resource: generic-out-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-out-label": {Generic Label for outbound traffic
"generic-label-type": "string", GenericLabelType
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
}
GENERALIZED-LABEL - Retrieve
Retrieve operation of resource: generalized-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generalized-label": {Generalized Label
"value": [No description
{
"entry": "integer" Generalized Label Value
}
]
}
}
VALUE - Retrieve
Retrieve operation of resource: value
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"value": {No description
"entry": "integer" Generalized Label Value
}
}
FLOW-SPEC - Retrieve
Retrieve operation of resource: flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flow-spec": {Flow spec object
"flow-peak-rate": "integer", The Flow Peak Rate in bytes per second
"flow-max-unit": "integer", The Flow Maximum Unit
"flow-max-burst": "integer", The Flow Maximum Burst
"flow-requested-rate": "integer", The Flow Requested Rate in bytes per second
"flow-average-rate": "integer", The Flow Average Rate in bytes per second
"flow-qos": "string", The Flow Quality of Service
"flow-slack": "integer", The Flow Slack
"flow-min-unit": "integer" The Flow Minimum Unit
}
}
GENERIC-FLOW-SPEC - Retrieve
Retrieve operation of resource: generic-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-flow-spec": {Generic Flow Spec object
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
},
"flow-spec-type": "string" FlowSpecType
}
}
G709OTN-FLOW-SPEC - Retrieve
Retrieve operation of resource: g709otn-flow-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-flow-spec": {G709 OTN FlowSpec
"flow-bit-rate": "integer", G709 OTN Flow Bit Rate
"flow-signal-type": "integer", G709 OTN Flow Signal Type (Refer G709 v3)
"flow-multiplier": "integer", G709 OTN Flow Multiplier
"flow-nvc": "integer" G709 OTN Flow NVC
}
}
RRO - Retrieve
Retrieve operation of resource: rro
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rro": {No description
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
]
},
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
},
"rro-type": "string", RROType
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
},
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
}
IPV4RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: ipv4rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4rro-sub-object": {IPV4 RRO Sub Object
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"rro-address": "string" The RRO IPV4 Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO IPV4 Subobject Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
LABEL-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: label-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"label-rro-sub-object": {Label RRO Sub Object
"variable-length-label": [No description
{
"entry": "integer" The RRO Subobject Variable Length Label
}
],
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
},
"is-label-variable-length": "boolean", Is the RRO Subobject Label Variable Length
"label": "integer" The RRO Subobject Label Value
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Label Flags
"is-global-label": "boolean" Label is Global across all interfaces
}
}
VARIABLE-LENGTH-LABEL - Retrieve
Retrieve operation of resource: variable-length-label
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"variable-length-label": {No description
"entry": "integer" The RRO Subobject Variable Length Label
}
}
UNNUMBERED-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: unnumbered-rro-sub-object
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unnumbered-rro-sub-object": {Unnumbered RRO Sub Object
"interface-id": "integer", The RRO Interface ID
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
},
"interface-address": "string" The RRO Interface Address
}
}
FLAGS - Retrieve
Retrieve operation of resource: flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flags": {The RRO Subobject Unnumbered Flags
"is-node-protection-available": "boolean", Node Protection Available
"is-protection-in-use": "boolean", Local Protection In Use
"is-node-id": "boolean", Node ID In Use
"is-protection-available": "boolean", Local Protection Available
"is-bandwidth-protected": "boolean" Bandwidth Protection Available
}
}
SRLG-RRO-SUB-OBJECT - Retrieve
Retrieve operation of resource: srlg-rro-sub-object
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srlg-rro-sub-object": {SRLG RRO Sub Object
"srl-gs": [No description
{
"entry": "integer" The RRO Subobject SRLGs
}
]
}
}
SRL-GS - Retrieve
Retrieve operation of resource: srl-gs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"srl-gs": {No description
"entry": "integer" The RRO Subobject SRLGs
}
}
HELLO-INSTANCE-DETAILS - Retrieve
Retrieve operation of resource: hello-instance-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-details": {Table of detailed info about hello instances
"hello-instance-detail": [No description
{
"hello-interval": "integer", Hello Interval
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", Neighbor Hello state
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
}
HELLO-INSTANCE-DETAIL - Retrieve
Retrieve operation of resource: hello-instance-detail
source-address destination-address:
string
in path
ID of source-address destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"hello-instance-detail": [No description
{
"hello-interval": "integer", Hello Interval
"source-address": "string", Source Address
"communication-lost-wrong-source-inst": "integer", Count of lost comm. due to wrong Source Inst
"destination-address": "string", Destination Address
"communication-lost-reason": "string", Reason why communication was lost
"destination-address-xr": "string", Destination address
"hello-interface": "string", Interface to use
"source-address-xr": "string", Source address
"destination-instance": "integer", Destination Instance
"instance-type": "string", Hello instance type
"source-instance": "integer", Source Instance
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-request-suppressed": "integer", Count of Hello Requests suppessed
"communication-lost-hello-missed": "integer", Lost Comm. Hello missed count
"hello-messages-received": "integer", Number of hello messages received
"missed-acks-allowed": "integer", Number of missed Hello allowed
"communication-lost-neighbor-disabled-hello": "integer", Count of lost comm. due to nbor disabling Hellos
"total-communication-lost": "integer", Total number of times communication got lost
"communication-lost-interface-down": "integer", Count of lost comm. due to interface down
"hello-instance-owner": "string", Hello instance owner
"neighbor-hello-state": "string", Neighbor Hello state
"communication-lost-wrong-destination-inst": "integer", Count of lost comm. due to wrong Destination\nInst
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-messages-sent": "integer" Number of hello messages sent
}
]
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
source-address destination-address:
string
in path
ID of source-address destination-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": {Hello up time
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
COMMUNICATION-LOST-TIME - Retrieve
Retrieve operation of resource: communication-lost-time
source-address destination-address:
string
in path
ID of source-address destination-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"communication-lost-time": {Time when communication was lost
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
GLOBAL-NEIGHBOR-DETAILS - Retrieve
Retrieve operation of resource: global-neighbor-details
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-details": {Table of detailed info about global neighbors
"global-neighbor-detail": [No description
{
"restart-state": "string", Current restart state
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Hello Interval (milliseconds)
"local-node-address": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"is-gr-enabled": "boolean", Is GR enabled
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [No description
{
"entry": "string" Total number of times communication got lost
}
],
{
"entry": "string" Total number of times communication got lost
}
],
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"neighbor-hello-state": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"lost-communication-total": [No description
{
"entry": "integer" Total number of times communication got lost
}
],
"neighbor-address": "string", Address of global neighbor
"missed-hellos": "integer", Hello missed count
"up-time": [No description
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"recovery-time": "integer", GR Recovery Time (milliseconds)
"node-address": "string", Neighbor node address
"is-restart-timer-running": "boolean", Is GR restart timer running
"pending-states": "integer", Number of pending states for this neighbor
"is-recovery-timer-running": "boolean", Is RSVP recovery timer running
"restart-time": "integer" GR Restart Time (milliseconds)
}
]
}
}
GLOBAL-NEIGHBOR-DETAIL - Retrieve
Retrieve operation of resource: global-neighbor-detail
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-detail": [No description
{
"restart-state": "string", Current restart state
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"hello-interval": "integer", Hello Interval (milliseconds)
"local-node-address": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"is-gr-enabled": "boolean", Is GR enabled
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"interface-neighbor": [No description
{
"entry": "string" Total number of times communication got lost
}
],
{
"entry": "string" Total number of times communication got lost
}
],
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"neighbor-hello-state": [No description
{
"entry": "string" Total number of times communication got lost
}
],
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
},
"lost-communication-total": [No description
{
"entry": "integer" Total number of times communication got lost
}
],
"neighbor-address": "string", Address of global neighbor
"missed-hellos": "integer", Hello missed count
"up-time": [No description
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"recovery-time": "integer", GR Recovery Time (milliseconds)
"node-address": "string", Neighbor node address
"is-restart-timer-running": "boolean", Is GR restart timer running
"pending-states": "integer", Number of pending states for this neighbor
"is-recovery-timer-running": "boolean", Is RSVP recovery timer running
"restart-time": "integer" GR Restart Time (milliseconds)
}
]
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
RESTART-TIME-LEFT - Retrieve
Retrieve operation of resource: restart-time-left
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-time-left": {How much restart time remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RESTART-TIMER-EXPIRY-TIME - Retrieve
Retrieve operation of resource: restart-timer-expiry-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"restart-timer-expiry-time": {When will restart timer expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIME-LEFT - Retrieve
Retrieve operation of resource: recovery-time-left
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-time-left": {How much recovery timer remains
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
RECOVERY-TIMER-EXP-TIME - Retrieve
Retrieve operation of resource: recovery-timer-exp-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"recovery-timer-exp-time": {Time at which recovery timer will expire
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-address": {No description
"entry": "string" Local node address
}
}
INTERFACE-NEIGHBOR - Retrieve
Retrieve operation of resource: interface-neighbor
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-neighbor": {No description
"entry": "string" Interface Neighbor List
}
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-hello-state": {No description
"entry": "string" Neighbor's hello state
}
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-reason": {No description
"entry": "string" Reason why communication was lost
}
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-total": {No description
"entry": "integer" Total number of times communication got lost
}
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
PSB-BRIEFS - Retrieve
Retrieve operation of resource: psb-briefs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-briefs": {Table of brief info about path state blocks
"psb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"destination-address": "string", Destination address
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-port": "integer", Source Port
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
]
}
}
PSB-BRIEF - Retrieve
Retrieve operation of resource: psb-brief
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"psb-brief": [No description
{
"destination-port": "integer", The Session Destination Port
"input-interface": "string", Path Input Interface
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"source-address": "string", Source Address
"sub-group-origin": "string", Subgroup Origin
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
},
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
},
"destination-address": "string", Destination address
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
},
"source-port": "integer", Source Port
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string", The Session Extended Tunnel ID
"vrf-name": "string", VRF Name
"session-type": "string", SessionType
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
},
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
]
}
SESSION - Retrieve
Retrieve operation of resource: session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session": {RSVP Session Information
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
}
RSVP-SESSION - Retrieve
Retrieve operation of resource: rsvp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-session": {RSVP Session
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
},
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
},
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
},
"session-type": "string", SessionType
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
}
IPV4 - Retrieve
Retrieve operation of resource: ipv4
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4": {UDP IPv4 session
"destination-port": "integer", The Session Destination Port
"protocol": "integer", Protocol type (originally defined in RFC 790,\nfurther values in subsequent RFCs)
"destination-address": "string" Destination address
}
}
IPV4-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-lsp-session": {IPv4 LSP session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
IPV4-UNI-SESSION - Retrieve
Retrieve operation of resource: ipv4-uni-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-uni-session": {IPv4 UNI session
"tunnel-id": "integer", The Session Tunnel ID
"destination-address": "string", Destination address
"extended-address": "string" The Session Extended Address
}
}
IPV4-P2MP-LSP-SESSION - Retrieve
Retrieve operation of resource: ipv4-p2mp-lsp-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ipv4-p2mp-lsp-session": {IPv4 P2MP LSP session
"tunnel-id": "integer", The Session Tunnel ID
"p2mp-id": "integer", The Point to Multipoint ID
"extended-tunnel-id": "string" The Session Extended Tunnel ID
}
}
S2L-SUB-LSP - Retrieve
Retrieve operation of resource: s2l-sub-lsp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"s2l-sub-lsp": {RSVP S2L Sub-LSP information
"s2l-destination-address": "string" S2L Sub-LSP Destination Address
}
}
TEMPLATE - Retrieve
Retrieve operation of resource: template
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"template": {RSVP Template
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
}
RSVP-FILTER - Retrieve
Retrieve operation of resource: rsvp-filter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rsvp-filter": {RSVP Filter
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
},
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
},
"filter-type": "string" FilterType
}
}
UDP-IPV4-SESSION - Retrieve
Retrieve operation of resource: udp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udp-ipv4-session": {UDP IPV4 FilterSpec
"source-port": "integer", Source Port
"source-address": "string" Source Address
}
}
P2MP-IPV4-SESSION - Retrieve
Retrieve operation of resource: p2mp-ipv4-session
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"p2mp-ipv4-session": {IPv4 P2MP LSP FilterSpec
"source-port": "integer", Source Port
"p2mp-sub-group-origin": "string", Point to Multipoint SubGroup Origin
"sub-group-id": "integer", Point to Multipoint Subgroup ID
"source-address": "string" Source Address
}
}
SESSION-ATTRIBUTE - Retrieve
Retrieve operation of resource: session-attribute
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"session-attribute": {RSVP Session Attribute
"reservation-priority": "integer", Reservation Priority
"setup-priority": "integer", Setup Priority
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
}
SESS-ATTRIBUTE-FLAGS - Retrieve
Retrieve operation of resource: sess-attribute-flags
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"sess-attribute-flags": {Session Attributes
"is-local-protect": "boolean", Local Protection
"is-node-protect": "boolean", Node Protection
"is-bandwidth-protect": "boolean", Bandwidth Protection
"is-shared-explicit-requested": "boolean", Shared Explicit Requested
"is-record-labels": "boolean" Records Labels
}
}
TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"traffic-spec": {RSVP Traffic Spec Info
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GENERIC-TRAFFIC-SPEC - Retrieve
Retrieve operation of resource: generic-traffic-spec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-traffic-spec": {RSVP Generic Traffic Spec Info
"tspec-type": "string", TspecType
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
},
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
}
G709OTN-TSPEC - Retrieve
Retrieve operation of resource: g709otn-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"g709otn-tspec": {G709 OTN Sender Tspec
"traffic-nvc": "integer", G709 OTN Traffic NVC
"traffic-multiplier": "integer", G709 OTN Traffic Multiplier
"traffic-bit-rate": "integer", G709 OTN Traffic Bit Rate
"traffic-signal-type": "integer" G709 OTN Traffic Signal Type (Refer G709 v3)
}
}
INTSRV-TSPEC - Retrieve
Retrieve operation of resource: intsrv-tspec
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intsrv-tspec": {Integrated Services Sender Tspec
"traffic-max-burst": "integer", Traffic Maximum Burst
"traffic-max-unit": "integer", Traffic Maximum Unit
"traffic-average-rate": "integer", Traffic Average Rate in bytes per second
"traffic-peak-rate": "integer", Traffic Peak Rate in bytes per second
"traffic-min-unit": "integer" Traffic Minimum Unit
}
}
GLOBAL-NEIGHBOR-BRIEFS - Retrieve
Retrieve operation of resource: global-neighbor-briefs
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-briefs": {Table of brief info about global neighbors
"global-neighbor-brief": [No description
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"lost-communication-reason": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"entry": "integer" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean", Is GR enabled
"local-node-address": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string", Neighbor node address
"neighbor-hello-state": [No description
{
"entry": "string" Neighbor Hello state
}
]
}
]
}
}
GLOBAL-NEIGHBOR-BRIEF - Retrieve
Retrieve operation of resource: global-neighbor-brief
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-brief": [No description
{
"restart-state": "string", Restart state
"neighbor-address": "string", Address of global neighbor
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
},
"lost-communication-reason": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"entry": "integer" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"is-gr-enabled": "boolean", Is GR enabled
"local-node-address": [No description
{
"entry": "string" Neighbor Hello state
}
],
{
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
],
"node-address": "string", Neighbor node address
"neighbor-hello-state": [No description
{
"entry": "string" Neighbor Hello state
}
]
}
]
}
GLOBAL-NEIGHBOR-FLAGS - Retrieve
Retrieve operation of resource: global-neighbor-flags
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"global-neighbor-flags": {Global Neighbor Flags
"is-application-mpls": "boolean", MPLS Application
"is-application-ouni": "boolean" OUNI Application
}
}
LOCAL-NODE-ADDRESS - Retrieve
Retrieve operation of resource: local-node-address
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"local-node-address": {No description
"entry": "string" Local node address
}
}
NEIGHBOR-HELLO-STATE - Retrieve
Retrieve operation of resource: neighbor-hello-state
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"neighbor-hello-state": {No description
"entry": "string" Neighbor Hello state
}
}
LOST-COMMUNICATION-REASON - Retrieve
Retrieve operation of resource: lost-communication-reason
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-reason": {No description
"entry": "string" Reason why communication was lost
}
}
LOST-COMMUNICATION-TOTAL - Retrieve
Retrieve operation of resource: lost-communication-total
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-total": {No description
"entry": "integer" Total number of times communication got lost
}
}
UP-TIME - Retrieve
Retrieve operation of resource: up-time
neighbor-address:
string
in path
ID of neighbor-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"up-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}
LOST-COMMUNICATION-TIME - Retrieve
Retrieve operation of resource: lost-communication-time
neighbor-address:
string
in path
ID of neighbor-address
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"lost-communication-time": {No description
"seconds": "string", Time Value in Seconds
"nanoseconds": "string" Time Value in Nano-seconds
}
}